docs: document hotfix capability#107
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The hotfix capability has no user-facing documentation. The workflows.md hotfix section was a stale stub that referenced a placeholder issue number and described the pre-capability behavior.
Changes
docs/workflows.md: replaces the stub with full hotfix documentation covering the trunk-first roll-forward default, per-environmentenv/<env>integration branches, the cherry-pick and resolution-pull-request flow, conflict UX (markers committed, force-push to resolve), rejoin and cleanup, and the generatedcascade-hotfix.yamlworkflow (triggers, jobs, prod environment gating, env/* protection suggestions).docs/versioning.md: adds the hotfix version segment, documenting both shapes: nestedvX.Y.Z-rc.N.hotfix.Mfor rc-based bases and a normal patch bump for published bases.docs/cli-reference.md: addshotfix planandhotfix finalizecommand references with flags, inputs, and outputs matching the implementation.Verification
grep -riE 'cfa|dxe|delivery' docs/returns clean.